Skip to content

Fix spelling and grammar issues in Task Server documentation#683

Merged
SteveMacenski merged 2 commits intoros-navigation:masterfrom
Clement795:fix/docs-nav2-task-server-grammar
May 20, 2025
Merged

Fix spelling and grammar issues in Task Server documentation#683
SteveMacenski merged 2 commits intoros-navigation:masterfrom
Clement795:fix/docs-nav2-task-server-grammar

Conversation

@Clement795
Copy link
Copy Markdown
Contributor

Hi,

I just completed the tutorial and noticed a few spelling errors in the documentation. I've gone ahead and corrected them to improve clarity and consistency. The changes mainly involve minor typos, such as the incorrect usage of "errors codes" instead of "error codes".

Let me know if you need any further adjustments or clarifications.

Thanks!

#############################

A nav2 task server consists of server side logic to complete different types of requests, usually called by the autonomy system or through the Behavior Tree Navigator. In this guide, we will discuss the core components needed to add a new task server to Nav2 (ex. Controller, Behavior, Smoother, Planner Servers). Namely, how to set up your new Lifecycle-Component Node for launch and state management and the communication of semantically meaningful error codes (if necessary).
A nav2 task server consists of server-side logic logic to complete different types of requests, usually called by the autonomy system or through the Behavior Tree Navigator. In this guide, we will discuss the core components needed to add a new task server to Nav2 (ex. Controller, Behavior, Smoother, Planner Servers). Namely, how to set up your new Lifecycle-Component Node for launch and state management and the communication of semantically meaningful error codes (if necessary).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logic twice?

A nav2 task server consists of server-side logic logic to complete different types of requests, usually called by the autonomy system or through the Behavior Tree Navigator. In this guide, we will discuss the core components needed to add a new task server to Nav2 (ex. Controller, Behavior, Smoother, Planner Servers). Namely, how to set up your new Lifecycle-Component Node for launch and state management and the communication of semantically meaningful error codes (if necessary).

While this tutorial does not cover how to add the complementary Behavior Tree Node to interact with this new Task Server, that is covered at length in :ref:`writing_new_nbt_plugin` so this Task Server can be invoked in the BTs in BT Navigator.
While this tutorial does not cover how to add the complementary Behavior Tree Node to interact with this new Task Server; that is covered at length in :ref:`writing_new_nbt_plugin` so this Task Server can be invoked in the BTs in BT Navigator.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should stay a , given its the second half of the sentence after "While ..., ...."

Copy link
Copy Markdown
Contributor Author

@Clement795 Clement795 May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're absolutely right about the comma ! just fixed that, along with the repetition of logic. Should be all good now

@SteveMacenski
Copy link
Copy Markdown
Member

@Clement795 please sign off with DCO - click on the failed job to see how. Then I can merge!

Clement795 added 2 commits May 1, 2025 18:53
Signed-off-by: Clement795 <clement.lepretre4@gmail.com>
Signed-off-by: Clement795 <clement.lepretre4@gmail.com>
@Clement795 Clement795 force-pushed the fix/docs-nav2-task-server-grammar branch from cf156f6 to c71c0d0 Compare May 1, 2025 16:54
@SteveMacenski SteveMacenski merged commit 398483b into ros-navigation:master May 20, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants